Generic IXI Visual Tcl Options

The following is a list of generic widget options that can be assigned to any widgets created by IXI Visual Tcl. All widgets have Geometry options and Object class options (used for specifying their positioning and their basic attributes). Some widgets also have the standard Dialog class options, Form class options, or Label class options. (For obvious reasons, these are not universally applicable to widgets; for example, a RadioButton does not need the global Dialog or Form options because it is not a dialog box or a Form.)

Some common terminology is used:

cmd

The name of a Tcl command or procedure associated with some widget. (For example, if the -callback cmd option is set for a given widget, it specifies that the procedure cmd is to be executed as a callback by that widget.)

object_name

The widget hierarchy of an object. Used when creating the object; for example, to create name as a child of parent, use the object_name parent.name.

widgetName

The name returned when creating an object. This name is used when doing commands such as Get, Set, Select, and Delete on widgets. It is also used when specifying a widget hierarchy for a new object.

The form of a widget name is defined as a path through the widget tree. As commands are sent to the server, widgets are created; then further child widgets are added. For example, a Form may have a dialog as its child, and the dialog may have a Text box and some PushButtons as children. The dialog will therefore have a name of the form: formname.dialogname; and the PushButtons will be named formname.dialogname.buttonname.

Note that all widget options are followed by the access attributes. These are as follows:

C

Indicates that the option can be set at widget creation time.

S

Indicates that the option can be set at any time after the widget has been created, using VtSetValues.

G

Indicates that the options can be retrieved by VtGetValues.

For example, an option that only has the C attribute must be set at widget creation time or not at all. An option with all attributes set may be applied to a widget at creation time, or at any subsequent time (using VtSetValues), and it is possible to retrieve the option using VtGetValues.